home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / aliasctl < prev    next >
Text File  |  2001-03-21  |  2KB  |  38 lines
  1. Synopsis:
  2.    $aliasctl(alias|assign get|set|match <lval> [<rval>])
  3.  
  4. Technical:
  5.    This function allows low-level manipulation of aliases and assigns.
  6.    The noun of the action is either "alias" or "assign".  The verb is
  7.    either "get", "set", or "match".  The "lval" must a valid variable name.
  8.    The "rval" is used only if the verb is "set", and is any sequence of
  9.    octets.
  10.  
  11.    * The "GET" verb allows you to retrieve the value of an alias or assign
  12.      named by "lval".
  13.    * The "SET" verb allows you to set the value of an alias or assign named
  14.      by "lval" to "rval".
  15.    * The "MATCH" verb allows you to retrieve the list of all same-level
  16.      variable names that begin with "lval" (ie, command completion).
  17.      Wildcards are not allowed, but the simple use of a single asterisk is
  18.      allowed to match all assigns or aliases.
  19.  
  20. Practical:
  21.    You would use this function if you needed to get the text value of an
  22.    alias.  For completeness, you can use this to get the value of an
  23.    assign, even though you can (obviously) get that value by $-referencing
  24.    it.  You can set the value of an assign (comparable to using ASSIGN),
  25.    and you can set the value of an alias (comparable to using ALIAS).  You
  26.    can get the list of aliases or assigns that "begin" with a certain
  27.    string, but it doesn't descend arrays (a period).
  28.  
  29. Examples:
  30.    $aliasctl(alias get join)            returns current value of alias "join"
  31.    $aliasctl(alias set join //channel)  sets an alias called "join"
  32.    $aliasctl(assign match foo)          returns all vars starting with "foo"
  33.    $aliasctl(alias match foo.)          returns all aliases of "foo" struct
  34.  
  35. See Also:
  36.    assign(5); alias(5); edit(8)
  37.  
  38.